[docs] Update ctc_loss function parameters in documentation #7597
+4
−49
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added parameters 'norm_by_times' and 'zero_infinity' to ctc_loss function documentation.
aztice
requested review from
Echo-Nie,
jzhang533,
mattheliu,
ooooo-create and
sunzhongkai588
as code owners
|
感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-7597.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
Correct formatting of the 'zero_infinity' parameter description in the CTC loss documentation.
SigureMo
reviewed
Oct 30, 2025
Add description for zero_infinity parameter in CTCLoss.
Updated the parameter mapping for PyTorch and PaddlePaddle in the CTCLoss documentation, including the addition of the 'zero_infinity' parameter for PaddlePaddle.
mattheliu
approved these changes
Oct 31, 2025
SigureMo
reviewed
Oct 31, 2025
...guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.nn.CTCLoss.md
Outdated
Show resolved
Hide resolved
…torch_more_args/torch.nn.CTCLoss.md
Removed the 'zero_infinity' parameter description from CTCLoss documentation.
…torch_more_args/torch.nn.functional.ctc_loss.md
|
@SigureMo 请再看下 |
SigureMo
reviewed
Nov 3, 2025
Co-authored-by: Nyakku Shigure <[email protected]>
SigureMo
reviewed
Nov 3, 2025
SigureMo
reviewed
Nov 3, 2025
SigureMo
reviewed
Nov 3, 2025
| - **blank** (int，可选) - 空格标记的 ID 值，其取值范围为 [0, num_classes + 1)。数据类型支持 int32。默认值为 0。 | ||
| - **reduction** (str，可选) - 指定应用于输出结果的计算方式，可选值有：``'none'``, ``'mean'``, ``'sum'``。设置为 ``'mean'`` 时，对 loss 值除以 label_lengths，并返回所得商的均值；设置为 ``'sum'`` 时，返回 loss 值的总和；设置为 ``'none'`` 时，则直接返回输出的 loss 值。默认值为 ``'mean'``。 | ||
| - **norm_by_times** (bool，可选) - 是否根据序列长度对梯度进行正则化。数据类型支持 bool。默认值为 False。 | ||
| - **zero_infinity** (bool，可选) - 如果 ``true``，将 可能 输出无限的 ``loss`` 设置为 ``0``。默认值: False。 |
There was a problem hiding this comment.
我感觉我平时写md或者这类文档的时候习惯比较awful（）
There was a problem hiding this comment.
Pull Request Overview
This PR adds the zero_infinity parameter to Paddle's CTCLoss APIs and removes outdated API difference documentation that incorrectly stated this parameter wasn't supported.
- Added
zero_infinityparameter topaddle.nn.functional.ctc_lossandpaddle.nn.CTCLoss - Removed API difference documentation files that claimed
zero_infinitywas unsupported in Paddle - Updated API documentation in Chinese to reflect the new parameter
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.nn.functional.ctc_loss.md | Removed obsolete API difference documentation since Paddle now supports zero_infinity |
| docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.nn.CTCLoss.md | Removed obsolete API difference documentation since Paddle now supports zero_infinity |
| docs/api/paddle/nn/functional/ctc_loss_cn.rst | Added zero_infinity parameter to function signature and parameter documentation |
| docs/api/paddle/nn/CTCLoss_cn.rst | Added zero_infinity parameter to class signature and parameter documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
SigureMo
reviewed
Nov 3, 2025
SigureMo
approved these changes
Nov 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
描述
将
norm_by_times以及zero_infinity同步于ctc_loss函数